/************************************************************************
 *   IRC - Internet Relay Chat, include/s_auth.h
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3, or (at your option)
 *   any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
/** @file
 * @brief Interface for DNS and ident lookups.
 * @version $Id: s_auth.h 2480 2009-05-20 09:33:32Z sirvulcan $
 */
#ifndef INCLUDED_s_auth_h
#define INCLUDED_s_auth_h
#ifndef INCLUDED_sys_types_h
#include <sys/types.h>
#define INCLUDED_sys_types_h
#endif
#ifndef INCLUDED_ircd_events_h
#include "ircd_events.h"
#endif

struct Client;
struct DNSReply;

struct AuthRequest {
  struct AuthRequest* next;      /* linked list node ptr */
  struct AuthRequest* prev;      /* linked list node ptr */
  struct Client*      client;    /* pointer to client struct for request */
  unsigned int        flags;     /* current state of request */
  int                 fd;        /* file descriptor for auth queries */
  struct Socket       socket;    /* socket descriptor for auth queries */
  struct Timer        timeout;   /* timeout timer for auth queries */
};

/*
 * flag values for AuthRequest
 * NAMESPACE: AM_xxx - Authentication Module
 */
#define AM_AUTH_CONNECTING   0x01
#define AM_AUTH_PENDING      0x02
#define AM_DNS_PENDING       0x04
#define AM_DNSBL_PENDING     0x08

#define AM_SOCKET            0x40 /* socket structure not destroyed */
#define AM_TIMEOUT           0x80 /* timer structure not destroyed */

#define AM_FREE_MASK         (AM_SOCKET | AM_TIMEOUT)

#define SetDNSBLPending(x)   ((x)->flags |= AM_DNSBL_PENDING)
#define ClearDNSBLPending(x) ((x)->flags &= ~AM_DNSBL_PENDING)
#define IsDNSBLPending(x)    ((x)->flags &  AM_DNSBL_PENDING)

#define SetDNSPending(x)     ((x)->flags |= AM_DNS_PENDING)
#define ClearDNSPending(x)   ((x)->flags &= ~AM_DNS_PENDING)
#define IsDNSPending(x)      ((x)->flags &  AM_DNS_PENDING)

#define SetAuthConnect(x)    ((x)->flags |= AM_AUTH_CONNECTING)
#define ClearAuthConnect(x)  ((x)->flags &= ~AM_AUTH_CONNECTING)
#define IsAuthConnect(x)     ((x)->flags &  AM_AUTH_CONNECTING)

#define SetAuthPending(x)    ((x)->flags |= AM_AUTH_PENDING)
#define ClearAuthPending(x)  ((x)->flags &= AM_AUTH_PENDING)
#define IsAuthPending(x)     ((x)->flags &  AM_AUTH_PENDING)

#define ClearAuth(x)         ((x)->flags &= ~(AM_AUTH_PENDING | AM_AUTH_CONNECTING))
#define IsDoingAuth(x)       ((x)->flags &  (AM_AUTH_PENDING | AM_AUTH_CONNECTING))


extern struct AuthRequest* AuthPollList; /* GLOBAL - auth queries pending io */

extern void start_auth(struct Client *);
extern void read_auth_reply(struct AuthRequest* req);
extern void send_auth_query(struct AuthRequest* req);
extern void destroy_auth_request(struct AuthRequest *req, int send_reports);
extern void auth_dnsbl_callback(void* vptr, struct DNSReply* reply);

#endif /* INCLUDED_s_auth_h */

